Skip to content

Conversation

@gsspdev
Copy link
Contributor

@gsspdev gsspdev commented Nov 27, 2025

Checklist

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR contains at most 5 new pages.
  • The PR is authored by me, or has been human-reviewed if it was created with AI or machine translation software.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):
  • Reference issue: #

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Nov 27, 2025
Copy link
Collaborator

@msaf9 msaf9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please resolve the build failure so that we can begin the actual review process.

@@ -0,0 +1,20 @@
# setopt

> Set/unset Z shell (zsh) options.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#18560

Suggested change
> Set/unset Z shell (zsh) options.
> Set/unset Z shell (Zsh) options.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer the uncapitalized version as 'zsh' is how you invoke 'Z Shell' from the command line. 'Zsh' implies that this is the formal name of 'Z Shell'. As far as I am aware it is not.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't important though. What's important is that this confusion is clarified simply to a beginner looking for a quick understanding of how to set options in Z Shell.

It is not clear from Z Shell's official documentation the right way how to do this or how to check which options are set/unset from the command line. Not to mention a beginner looking for this documentation might not know that the tool is even called 'Z Shell' or that 'setopt' has anything to do with 'zsh'/'Z Shell' to begin with.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer the uncapitalized version as 'zsh' is how you invoke 'Z Shell' from the command line. 'Zsh' implies that this is the formal name of 'Z Shell'. As far as I am aware it is not.

It appears I'm wrong about this. I could go either way, but I think the rule about capitalizing shells should be reversed if the shell isn't capitalized in it's documentation.

@msaf9
Copy link
Collaborator

msaf9 commented Nov 28, 2025

Hello @gsspdev, could you please fix the build failure and address one of the comments from the review?

gsspdev and others added 4 commits November 28, 2025 12:11
Co-authored-by: Sahil Afrid Farookhi <[email protected]>
Co-authored-by: Sahil Afrid Farookhi <[email protected]>
Co-authored-by: Sahil Afrid Farookhi <[email protected]>
Co-authored-by: Lena Pastwa <[email protected]>
@tldr-bot

This comment was marked as resolved.

@Managor Managor mentioned this pull request Nov 29, 2025
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants